Engine Class

The Engine Class is the basic Creator class. You always need to create at least one Engine Object in your program.

Methods:

Methods/Properties

Description

Error As SFPackErrorConst [R]

Get the current Error status of the object.

ErrorStr As String [R]

Returns the current Error status as a descriptive text.

OpenSF2 (cFile as String) As SF2File

Opens a SF2 file and returns an SF2 file object.
If there's an error Nothing is returned (to get further information use the Engine.Error property).
cFile can be any path including a network path.

OpenSFPack (cFile as String) As SFPackFile

Opens a SFPack file and returns an SFPack file object.
If there's an error Nothing is returned (to get further information use the Engine.Error property).
cFile can be any path including a network path.

Events:

Event

Description

Progress (ByVal nPercent As Integer)

This event is triggered either by the SF2File.Pack or the SFPackFile.Inflate method.

This event can be used to update a progress bar with the completion percent of the current file processing.

You can also cancel the current packing or inflation by calling the SF2File.Cancel or SFPackFile.Cancel method.

Visual Basic Source Example

Methods/Properties	Description
Error As SFPackErrorConst [R]	Get the current Error status of the object.
ErrorStr As String [R]	Returns the current Error status as a descriptive text.
OpenSF2 (cFile as String) As SF2File	Opens a SF2 file and returns an SF2 file object. If there's an error Nothing is returned (to get further information use the Engine.Error property). cFile can be any path including a network path.
OpenSFPack (cFile as String) As SFPackFile	Opens a SFPack file and returns an SFPack file object. If there's an error Nothing is returned (to get further information use the Engine.Error property). cFile can be any path including a network path.